

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>federatedml.model_selection package &mdash; FATE 1.0 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script type="text/javascript" src="_static/jquery.js"></script>
        <script type="text/javascript" src="_static/underscore.js"></script>
        <script type="text/javascript" src="_static/doctools.js"></script>
        <script type="text/javascript" src="_static/language_data.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="index.html" class="icon icon-home"> FATE
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <!-- Local TOC -->
              <div class="local-toc"><ul>
<li><a class="reference internal" href="#">federatedml.model_selection package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-federatedml.model_selection.KFold">federatedml.model_selection.KFold module</a></li>
<li><a class="reference internal" href="#module-federatedml.model_selection.cross_validate">federatedml.model_selection.cross_validate module</a></li>
<li><a class="reference internal" href="#module-federatedml.model_selection.indices">federatedml.model_selection.indices module</a></li>
<li><a class="reference internal" href="#module-federatedml.model_selection.mini_batch">federatedml.model_selection.mini_batch module</a></li>
<li><a class="reference internal" href="#module-federatedml.model_selection">Module contents</a></li>
</ul>
</li>
</ul>
</div>
            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">FATE</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>federatedml.model_selection package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/federatedml.model_selection.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="federatedml-model-selection-package">
<h1>federatedml.model_selection package<a class="headerlink" href="#federatedml-model-selection-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="federatedml.model_selection.test.html">federatedml.model_selection.test package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="federatedml.model_selection.test.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.model_selection.test.html#module-federatedml.model_selection.test.KFold_test">federatedml.model_selection.test.KFold_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.model_selection.test.html#module-federatedml.model_selection.test.join_test">federatedml.model_selection.test.join_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.model_selection.test.html#module-federatedml.model_selection.test.mini_batch_test">federatedml.model_selection.test.mini_batch_test module</a></li>
<li class="toctree-l2"><a class="reference internal" href="federatedml.model_selection.test.html#module-federatedml.model_selection.test">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-federatedml.model_selection.KFold">
<span id="federatedml-model-selection-kfold-module"></span><h2>federatedml.model_selection.KFold module<a class="headerlink" href="#module-federatedml.model_selection.KFold" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="federatedml.model_selection.KFold.KFold">
<em class="property">class </em><code class="descclassname">federatedml.model_selection.KFold.</code><code class="descname">KFold</code><a class="reference internal" href="_modules/federatedml/model_selection/KFold.html#KFold"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.KFold.KFold" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#federatedml.model_selection.cross_validate.BaseCrossValidator" title="federatedml.model_selection.cross_validate.BaseCrossValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">federatedml.model_selection.cross_validate.BaseCrossValidator</span></code></a></p>
<dl class="method">
<dt id="federatedml.model_selection.KFold.KFold.evaluate">
<code class="descname">evaluate</code><span class="sig-paren">(</span><em>eval_data</em>, <em>fold_name</em>, <em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/KFold.html#KFold.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.KFold.KFold.evaluate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.model_selection.KFold.KFold.run">
<code class="descname">run</code><span class="sig-paren">(</span><em>component_parameters</em>, <em>data_inst</em>, <em>original_model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/KFold.html#KFold.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.KFold.KFold.run" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.model_selection.KFold.KFold.split">
<code class="descname">split</code><span class="sig-paren">(</span><em>data_inst</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/KFold.html#KFold.split"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.KFold.KFold.split" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-federatedml.model_selection.cross_validate">
<span id="federatedml-model-selection-cross-validate-module"></span><h2>federatedml.model_selection.cross_validate module<a class="headerlink" href="#module-federatedml.model_selection.cross_validate" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="federatedml.model_selection.cross_validate.BaseCrossValidator">
<em class="property">class </em><code class="descclassname">federatedml.model_selection.cross_validate.</code><code class="descname">BaseCrossValidator</code><a class="reference internal" href="_modules/federatedml/model_selection/cross_validate.html#BaseCrossValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.cross_validate.BaseCrossValidator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="federatedml.model_selection.cross_validate.BaseCrossValidator.display_cv_result">
<code class="descname">display_cv_result</code><span class="sig-paren">(</span><em>cv_results</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/cross_validate.html#BaseCrossValidator.display_cv_result"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.cross_validate.BaseCrossValidator.display_cv_result" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.model_selection.cross_validate.BaseCrossValidator.split">
<code class="descname">split</code><span class="sig-paren">(</span><em>data_inst</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/cross_validate.html#BaseCrossValidator.split"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.cross_validate.BaseCrossValidator.split" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-federatedml.model_selection.indices">
<span id="federatedml-model-selection-indices-module"></span><h2>federatedml.model_selection.indices module<a class="headerlink" href="#module-federatedml.model_selection.indices" title="Permalink to this headline">¶</a></h2>
<p>This module provide some utilized methods that operate the index of distributed data</p>
<dl class="function">
<dt id="federatedml.model_selection.indices.collect_index">
<code class="descclassname">federatedml.model_selection.indices.</code><code class="descname">collect_index</code><span class="sig-paren">(</span><em>data_insts</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/indices.html#collect_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.indices.collect_index" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-federatedml.model_selection.mini_batch">
<span id="federatedml-model-selection-mini-batch-module"></span><h2>federatedml.model_selection.mini_batch module<a class="headerlink" href="#module-federatedml.model_selection.mini_batch" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="federatedml.model_selection.mini_batch.MiniBatch">
<em class="property">class </em><code class="descclassname">federatedml.model_selection.mini_batch.</code><code class="descname">MiniBatch</code><span class="sig-paren">(</span><em>data_inst</em>, <em>batch_size=320</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/mini_batch.html#MiniBatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.mini_batch.MiniBatch" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="federatedml.model_selection.mini_batch.MiniBatch.mini_batch_data_generator">
<code class="descname">mini_batch_data_generator</code><span class="sig-paren">(</span><em>result='data'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/mini_batch.html#MiniBatch.mini_batch_data_generator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.mini_batch.MiniBatch.mini_batch_data_generator" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate mini-batch data or index</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>result</strong> (<em>str</em><em>, </em><em>'data'</em><em> or </em><em>'index'</em><em>, </em><em>default: 'data'</em>) – Specify you want batch data or batch index.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">A generator that might generate data or index.</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-federatedml.model_selection">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-federatedml.model_selection" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="federatedml.model_selection.MiniBatch">
<em class="property">class </em><code class="descclassname">federatedml.model_selection.</code><code class="descname">MiniBatch</code><span class="sig-paren">(</span><em>data_inst</em>, <em>batch_size=320</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/mini_batch.html#MiniBatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.MiniBatch" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="federatedml.model_selection.MiniBatch.mini_batch_data_generator">
<code class="descname">mini_batch_data_generator</code><span class="sig-paren">(</span><em>result='data'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/mini_batch.html#MiniBatch.mini_batch_data_generator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.MiniBatch.mini_batch_data_generator" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate mini-batch data or index</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>result</strong> (<em>str</em><em>, </em><em>'data'</em><em> or </em><em>'index'</em><em>, </em><em>default: 'data'</em>) – Specify you want batch data or batch index.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">A generator that might generate data or index.</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="federatedml.model_selection.KFold">
<em class="property">class </em><code class="descclassname">federatedml.model_selection.</code><code class="descname">KFold</code><a class="reference internal" href="_modules/federatedml/model_selection/KFold.html#KFold"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.KFold" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#federatedml.model_selection.cross_validate.BaseCrossValidator" title="federatedml.model_selection.cross_validate.BaseCrossValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">federatedml.model_selection.cross_validate.BaseCrossValidator</span></code></a></p>
<dl class="method">
<dt id="federatedml.model_selection.KFold.evaluate">
<code class="descname">evaluate</code><span class="sig-paren">(</span><em>eval_data</em>, <em>fold_name</em>, <em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/KFold.html#KFold.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.KFold.evaluate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.model_selection.KFold.run">
<code class="descname">run</code><span class="sig-paren">(</span><em>component_parameters</em>, <em>data_inst</em>, <em>original_model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/KFold.html#KFold.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.KFold.run" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="federatedml.model_selection.KFold.split">
<code class="descname">split</code><span class="sig-paren">(</span><em>data_inst</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/federatedml/model_selection/KFold.html#KFold.split"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#federatedml.model_selection.KFold.split" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
</div>


           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2019, FATE_TEAM

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>